feat(analyzer): improvements to reporting and circular $ref discovery #723
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erunion
commented
Dec 7, 2022
| * | ||
| * @private | ||
| */ | ||
| cb?: () => void; |
There was a problem hiding this comment.
I don't like having this option here just for testing purposes but because I changed way we use @readme/json-schema-ref-parser to instantiate it with a class constructor it's really hard with Jest to spy on new $RefParser.dereference() now to ensure that it's only ever called once.
Adding this callback in here, and then calling it in the .then() below replicates this behavior.
erunion
commented
Dec 7, 2022
| // with the schema path (file path, url, whatever) that the schema exists in. Because | ||
| // we don't care about this information for this reporting mechanism, and only the | ||
| // $ref pointer, we're removing it. | ||
| return `#${pointer.split('#')[1]}`; |
There was a problem hiding this comment.
Example pointer coming back from json-schema-ref-parser looks like /path/to/file.yaml#/components/schemas/name. We only need the latter part so that's what this is doing here.
erunion
requested review from
kanadgupta,
a team,
Dashron and
julshotal
and removed request for
a team
kanadgupta
approved these changes
Dec 7, 2022
Co-authored-by: Kanad Gupta <[email protected]>
Co-authored-by: Kanad Gupta <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
$refschema pointer (one that's prefixed with a#).$refpointers to us when they're discovered during dereferencing. feat: surfacing circular $refs in a newcircularRefsproperty on the parser json-schema-ref-parser#58Oas.getCircularReferences()method that will use the afformetioned API to return a list of every circular$refthat exists within the API definition.Finally, I've updated the
circularRefsOpenAPI analyzer query to use these new APIs so it returns exactly what circular$refs exist within an API definition, and not all$refs that still remain in the API definition after dereferencing:Footnotes
What's the analyzer? It's the new JSONPath query system I've been building for the new
openapi:usescommand in rdme. ↩